sigmund

What is sigmund?

The sigmund npm package is used to generate unique fingerprints for objects. It is particularly useful for caching and memoization purposes, where you need a consistent and unique identifier for complex objects.

What are sigmund's main functionalities?

Generate Fingerprint

This feature allows you to generate a unique fingerprint for a given object. The fingerprint can be used to identify the object uniquely, which is useful in caching and memoization.

const sigmund = require('sigmund');
const obj = { a: 1, b: { c: 2 } };
const fingerprint = sigmund(obj);
console.log(fingerprint);

Other packages similar to sigmund

object-hash

The object-hash package generates a hash value for an object. It offers more customization options compared to sigmund, such as different hashing algorithms and encoding formats.

json-stable-stringify

The json-stable-stringify package provides a way to stringify objects in a consistent order, which can then be hashed or used as a unique identifier. It is more focused on producing a consistent JSON string representation of an object.

fast-json-stable-stringify

Similar to json-stable-stringify, this package offers a faster implementation for producing a consistent JSON string representation of an object. It is optimized for performance.

README

sigmund

Quick and dirty signatures for Objects.

This is like a much faster deepEquals comparison, which returns a string key suitable for caches and the like.

Usage

function doSomething (someObj) {
  var key = sigmund(someObj, maxDepth) // max depth defaults to 10
  var cached = cache.get(key)
  if (cached) return cached

  var result = expensiveCalculation(someObj)
  cache.set(key, result)
  return result
}

The resulting key will be as unique and reproducible as calling JSON.stringify or util.inspect on the object, but is much faster. In order to achieve this speed, some differences are glossed over. For example, the object {0:'foo'} will be treated identically to the array ['foo'].

Also, just as there is no way to summon the soul from the scribblings of a cocaine-addled psychoanalyst, there is no way to revive the object from the signature string that sigmund gives you. In fact, it's barely even readable.

As with util.inspect and JSON.stringify, larger objects will produce larger signature strings.

Because sigmund is a bit less strict than the more thorough alternatives, the strings will be shorter, and also there is a slightly higher chance for collisions. For example, these objects have the same signature:

var obj1 = {a:'b',c:/def/,g:['h','i',{j:'',k:'l'}]}
var obj2 = {a:'b',c:'/def/',g:['h','i','{jkl']}

Like a good Freudian, sigmund is most effective when you already have some understanding of what you're looking for. It can help you help yourself, but you must be willing to do some work as well.

Cycles are handled, and cyclical objects are silently omitted (though the key is included in the signature output.)

The second argument is the maximum depth, which defaults to 10, because that is the maximum object traversal depth covered by most insurance carriers.